
<!DOCTYPE html>
<!--

    Copyright (c) 2017, 2019 Oracle and/or its affiliates. All rights reserved.

    This program and the accompanying materials are made available under the
    terms of the Eclipse Public License v. 2.0, which is available at
    http://www.eclipse.org/legal/epl-2.0.

    This Source Code may also be made available under the following Secondary
    Licenses when the conditions for such availability set forth in the
    Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
    version 2 with the GNU Classpath Exception, which is available at
    https://www.gnu.org/software/classpath/license.html.

    SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0

-->
<!-- Portions Copyright [2019] [Payara Foundation and/or its affiliates] -->
<html lang="en">
  <head>
    <meta charset="utf-8"/>
    <title>restore-domain</title>
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <link href="css/style.css" rel="stylesheet">
    <script src="https://use.fontawesome.com/96c4d89611.js"></script>
  </head>
  <body>
<table id="doc-title" cellspacing="0" cellpadding="0">
  <tr>
  <td align="left" valign="top">
  <b>restore-domain</b><br />
  </td>
  </tr>
</table>
<hr />

<table width="90%" id="top-nav" cellspacing="0" cellpadding="0">
	<colgroup>
		<col width="12%"/>
		<col width="12%"/>
		<col width="*"/>
	</colgroup>
	<tr>
		<td align="left">
		<a href="restart-local-instance.html">
			<span class="vector-font"><i class="fa fa-arrow-circle-left" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Previous</span>
		</a>
		</td>

		<td align="left">
		<a href="rollback-transaction.html">
			<span class=" vector-font"><i class="fa fa-arrow-circle-right vector-font" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Next</span>
		</a>
		</td>

		<td align="right">
		<a href="toc.html">
			<span class=" vector-font"><i class="fa fa-list vector-font" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Contents</span>
		</a>
		</td>
	</tr>
</table>


<div id="preamble">
<div class="sectionbody">
<div class="paragraph">
<p><a id="restore-domain-1"></a><a id="GSRFM00221"></a><a id="restore-domain"></a></p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_restore_domain">restore-domain</h2>
<div class="sectionbody">
<div class="paragraph">
<p>restores files from backup</p>
</div>
<div id="sthref2002" class="paragraph">
<p>Synopsis</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="prettyprint highlight"><code class="language-oac_no_warn" data-lang="oac_no_warn">asadmin [asadmin-options] restore-domain [--help]
[--long[={false|true}]]
[--filename backup-filename]
[--domaindir domain-root-dir]
[--backupdirbackup-directory]
[--backupconfigbackup-config-name]
[--force[={false|true}]]
[domain-name]</code></pre>
</div>
</div>
<div id="sthref2003" class="paragraph">
<p>Description</p>
</div>
<div class="paragraph">
<p>This command restores files under the domain from a backup directory.</p>
</div>
<div class="paragraph">
<p>The <code>restore-domain</code> command is supported in local mode only.</p>
</div>
<div id="sthref2004" class="paragraph">
<p>Options</p>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1">asadmin-options</dt>
<dd>
<p>Options for the <code>asadmin</code> utility. For information about these
options, see the <a href="asadmin.html#asadmin-1m"><code>asadmin</code>(1M)</a> help page.</p>
</dd>
<dt class="hdlist1"><code>--help</code></dt>
<dt class="hdlist1"><code>-?</code></dt>
<dd>
<p>Displays the help text for the subcommand.</p>
</dd>
<dt class="hdlist1"><code>--long</code></dt>
<dt class="hdlist1"><code>-l</code></dt>
<dd>
<p>Displays detailed information about the restore operation.<br>
The default value is <code>false</code>.</p>
</dd>
<dt class="hdlist1"><code>--filename</code></dt>
<dd>
<p>Specifies the name of the backup file to use as the source.</p>
</dd>
<dt class="hdlist1"><code>--domaindir</code></dt>
<dd>
<p>Specifies the domain root directory, the parent directory of the
domain to restore.<br>
The default value is as-install`/domains`.</p>
</dd>
<dt class="hdlist1"><code>--backupdir</code></dt>
<dd>
<p>Specifies the directory under which the backup file is stored.<br>
The default value is as-install`/domains/<code>domain-dir</code>/backups`. If the
domain is not in the default location, the location is
domain-dir`/backups`.</p>
</dd>
<dt class="hdlist1"><code>--backupconfig</code></dt>
<dd>
<p>(Supported only in Oracle Payara Server.) The name of the domain
backup configuration in the backup directory under which the backup
file is stored.</p>
</dd>
<dt class="hdlist1"><code>--force</code></dt>
<dd>
<p>Causes the restore operation to continue even when the name of the
domain to restore does not match the name of the domain stored in the
backup file.<br>
The default value is <code>false</code>.</p>
</dd>
</dl>
</div>
<div id="sthref2005" class="paragraph">
<p>Operands</p>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1">domain-name</dt>
<dd>
<p>Specifies the name of the domain to restore.<br>
This operand is optional if only one domain exists in the
\{product---name} installation.<br>
If the specified domain name does not match the domain name stored in
the backup file, an error occurs unless the <code>--force</code> option is
specified.</p>
</dd>
</dl>
</div>
<div id="sthref2006" class="paragraph">
<p>Exit Status</p>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1">0</dt>
<dd>
<p>subcommand executed successfully</p>
</dd>
<dt class="hdlist1">1</dt>
<dd>
<p>error in executing the subcommand</p>
</dd>
</dl>
</div>
<div id="sthref2007" class="paragraph">
<p>See Also</p>
</div>
<div class="paragraph">
<p><a href="asadmin.html#asadmin-1m"><code>asadmin</code>(1M)</a></p>
</div>
<div class="paragraph">
<p><a href="backup-domain.html#backup-domain-1"><code>backup-domain</code>(1)</a>,
<a href="list-backups.html#list-backups-1"><code>list-backups</code>(1)</a></p>
</div>
</div>
</div>

<hr />

<table width="90%" id="bottom-nav" cellspacing="0" cellpadding="0">
	<colgroup>
		<col width="12%"/>
		<col width="12%"/>
		<col width="*"/>
	</colgroup>
	<tr>		
		<td align="left">
		<a href="restart-local-instance.html">
			<span class=" vector-font"><i class="fa fa-arrow-circle-left" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Previous</span>
		</a>
		</td>

		<td align="left">
		<a href="rollback-transaction.html">
			<span class="vector-font"><i class="fa fa-arrow-circle-right vector-font" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Next</span>
		</a>
		</td>

		<td align="right">
		<a href="toc.html">
			<span class="vector-font"><i class="fa fa-list vector-font" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Contents</span>
		</a>
		</td>
	</tr>
</table>

<span id="copyright">
        <img src="/resource/reference/img/eclipse_foundation_logo_tiny.png" height="20px" alt="Eclipse Foundation Logo" align="top"/>&nbsp;            
        <span >Copyright&nbsp;&copy;&nbsp;2019,&nbsp;Oracle&nbsp;and/or&nbsp;its&nbsp;affiliates.&nbsp;All&nbsp;rights&nbsp;reserved.</span>
</span>

</body>
</html>
